Skip to content

rustdoc: correctly clean cross-crate opaque types #116735

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Conversation

fmease
Copy link
Member

@fmease fmease commented Oct 14, 2023

Opening a PR for a patch I had lying around for roughly 3 months to motivate myself to finish it.
Fixes bevyengine/bevy#8898 (#113015, subitem (1)).
Part of #113015.

Before/after (cross-crate re-export scenario):

- pub fn rpit_fn() -> impl Fn()
+ pub fn rpit_fn() -> impl Fn() -> bool
- pub fn rpit_fn_mut() -> impl for<'a> FnMut(&'a str)
+ pub fn rpit_fn_mut() -> impl for<'a> FnMut(&'a str) -> &'a str

Draft: See FIXMEs.

r? @ghost

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Oct 14, 2023
@fmease fmease added the A-cross-crate-reexports Area: Documentation that has been re-exported from a different crate label Oct 14, 2023
@bors
Copy link
Collaborator

bors commented Oct 30, 2023

☔ The latest upstream changes (presumably #117405) made this pull request unmergeable. Please resolve the merge conflicts.

@fmease fmease force-pushed the rustdoc-x-crate-type-bindings-supertrait-bounds branch from 6835191 to a501bbe Compare October 31, 2023 10:50
@Dylan-DPC Dylan-DPC added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 15, 2023
@Dylan-DPC
Copy link
Member

@fmease any updates on it?

r? rustdoc

@fmease
Copy link
Member Author

fmease commented Nov 15, 2023

Ye, this PR could be merged as is (once I've removed some of the temporary FIXME comments). It's a draft since it's not super DRY and it should be generalized to fix more issues (some of which are mentioned in #113015). However, that'd require rewriting a lot of things which I didn't have the energy to do yet. Imma decide how to proceed today or in the coming days.

@bors
Copy link
Collaborator

bors commented Feb 22, 2024

☔ The latest upstream changes (presumably #121370) made this pull request unmergeable. Please resolve the merge conflicts.

@Dylan-DPC
Copy link
Member

@fmease any updates on this? thanks

@fmease
Copy link
Member Author

fmease commented Apr 9, 2024

Coincidentally I will send a new and more extensive PR in a few hours hopefully 🤞, one that should fix #113015 completely. Closing this PR.

@fmease fmease closed this Apr 9, 2024
@fmease fmease deleted the rustdoc-x-crate-type-bindings-supertrait-bounds branch April 9, 2024 13:50
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
A-cross-crate-reexports Area: Documentation that has been re-exported from a different crate S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Function signature of resource_equals differs from implementation in docs
5 participants